

<!DOCTYPE html>
<html class="writer-html5" lang="en" >
<head>
  <meta charset="utf-8" />
  
  <meta name="viewport" content="width=device-width, initial-scale=1.0" />
  
  <title>Index &mdash; Command Line 0.1 documentation</title>
  

  
  <link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
  <link rel="stylesheet" href="_static/pygments.css" type="text/css" />

  
  

  
  

  

  
  <!--[if lt IE 9]>
    <script src="_static/js/html5shiv.min.js"></script>
  <![endif]-->
  
    
      <script type="text/javascript" id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
        <script src="_static/jquery.js"></script>
        <script src="_static/underscore.js"></script>
        <script src="_static/doctools.js"></script>
    
    <script type="text/javascript" src="_static/js/theme.js"></script>

    
    <link rel="index" title="Index" href="#" />
    <link rel="search" title="Search" href="search.html" /> 
</head>

<body class="wy-body-for-nav">

   
  <div class="wy-grid-for-nav">
    
    <nav data-toggle="wy-nav-shift" class="wy-nav-side">
      <div class="wy-side-scroll">
        <div class="wy-side-nav-search" >
          

          
            <a href="index.html" class="icon icon-home"> Command Line
          

          
          </a>

          
            
            
          

          
<div role="search">
  <form id="rtd-search-form" class="wy-form" action="search.html" method="get">
    <input type="text" name="q" placeholder="Search docs" />
    <input type="hidden" name="check_keywords" value="yes" />
    <input type="hidden" name="area" value="default" />
  </form>
</div>

          
        </div>

        
        <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
          
            
            
              
            
            
              <!-- Local TOC -->
              <div class="local-toc"></div>
            
          
        </div>
        
      </div>
    </nav>

    <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">

      
      <nav class="wy-nav-top" aria-label="top navigation">
        
          <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
          <a href="index.html">Command Line</a>
        
      </nav>


      <div class="wy-nav-content">
        
        <div class="rst-content">
        
          

















<div role="navigation" aria-label="breadcrumbs navigation">

  <ul class="wy-breadcrumbs">
    
      <li><a href="index.html" class="icon icon-home"></a> &raquo;</li>
        
      <li>Index</li>
    
    
      <li class="wy-breadcrumbs-aside">
        
          
        
      </li>
    
  </ul>

  
  <hr/>
</div>
          <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
           <div itemprop="articleBody">
            

<h1 id="index">Index</h1>

<div class="genindex-jumpbox">
 <a href="#B"><strong>B</strong></a>
 | <a href="#C"><strong>C</strong></a>
 | <a href="#E"><strong>E</strong></a>
 | <a href="#F"><strong>F</strong></a>
 | <a href="#G"><strong>G</strong></a>
 | <a href="#H"><strong>H</strong></a>
 | <a href="#I"><strong>I</strong></a>
 | <a href="#K"><strong>K</strong></a>
 | <a href="#L"><strong>L</strong></a>
 | <a href="#M"><strong>M</strong></a>
 | <a href="#O"><strong>O</strong></a>
 | <a href="#P"><strong>P</strong></a>
 | <a href="#Q"><strong>Q</strong></a>
 | <a href="#R"><strong>R</strong></a>
 | <a href="#S"><strong>S</strong></a>
 | <a href="#T"><strong>T</strong></a>
 | <a href="#U"><strong>U</strong></a>
 | <a href="#W"><strong>W</strong></a>
 
</div>
<h2 id="B">B</h2>
<table style="width: 100%" class="indextable genindextable"><tr>
  <td style="width: 33%; vertical-align: top;"><ul>
      <li><a href="command_line.html#command_line.style.BaseStyle.back">back (command_line.style.BaseStyle attribute)</a>

      <ul>
        <li><a href="command_line.html#command_line.style.BlackRedStyle.back">(command_line.style.BlackRedStyle attribute)</a>
</li>
      </ul></li>
      <li><a href="command_line.html#command_line.colorful.background_replace">background_replace() (in module command_line.colorful)</a>
</li>
  </ul></td>
  <td style="width: 33%; vertical-align: top;"><ul>
      <li><a href="command_line.html#command_line.shell.BaseShell">BaseShell (class in command_line.shell)</a>
</li>
      <li><a href="command_line.html#command_line.style.BaseStyle">BaseStyle (class in command_line.style)</a>
</li>
      <li><a href="command_line.html#command_line.style.BlackRedStyle">BlackRedStyle (class in command_line.style)</a>
</li>
  </ul></td>
</tr></table>

<h2 id="C">C</h2>
<table style="width: 100%" class="indextable genindextable"><tr>
  <td style="width: 33%; vertical-align: top;"><ul>
      <li><a href="command_line.html#command_line.shell.BaseShell.can_not_find_error">can_not_find_error() (command_line.shell.BaseShell method)</a>
</li>
      <li><a href="command_line.html#command_line.style.BaseStyle.clear">clear() (command_line.style.BaseStyle method)</a>
</li>
      <li><a href="command_line.html#command_line.colorful.colorful">colorful() (in module command_line.colorful)</a>
</li>
      <li><a href="command_line.html#command_line.shell.BaseShell.COMMAND_GUIDANCE">COMMAND_GUIDANCE (command_line.shell.BaseShell attribute)</a>
</li>
      <li>
    command_line

      <ul>
        <li><a href="command_line.html#module-command_line">module</a>
</li>
      </ul></li>
      <li>
    command_line.colorful

      <ul>
        <li><a href="command_line.html#module-command_line.colorful">module</a>
</li>
      </ul></li>
      <li>
    command_line.examples

      <ul>
        <li><a href="command_line.examples.html#module-command_line.examples">module</a>
</li>
      </ul></li>
  </ul></td>
  <td style="width: 33%; vertical-align: top;"><ul>
      <li>
    command_line.examples.example_shell

      <ul>
        <li><a href="command_line.examples.html#module-command_line.examples.example_shell">module</a>
</li>
      </ul></li>
      <li>
    command_line.exceptions

      <ul>
        <li><a href="command_line.html#module-command_line.exceptions">module</a>
</li>
      </ul></li>
      <li>
    command_line.history

      <ul>
        <li><a href="command_line.html#module-command_line.history">module</a>
</li>
      </ul></li>
      <li>
    command_line.shell

      <ul>
        <li><a href="command_line.html#module-command_line.shell">module</a>
</li>
      </ul></li>
      <li>
    command_line.style

      <ul>
        <li><a href="command_line.html#module-command_line.style">module</a>
</li>
      </ul></li>
  </ul></td>
</tr></table>

<h2 id="E">E</h2>
<table style="width: 100%" class="indextable genindextable"><tr>
  <td style="width: 33%; vertical-align: top;"><ul>
      <li><a href="command_line.html#command_line.shell.BaseShell.echo">echo() (command_line.shell.BaseShell method)</a>

      <ul>
        <li><a href="command_line.html#command_line.style.BaseStyle.echo">(command_line.style.BaseStyle method)</a>
</li>
      </ul></li>
  </ul></td>
  <td style="width: 33%; vertical-align: top;"><ul>
      <li><a href="command_line.examples.html#command_line.examples.example_shell.ExampleShell">ExampleShell (class in command_line.examples.example_shell)</a>
</li>
  </ul></td>
</tr></table>

<h2 id="F">F</h2>
<table style="width: 100%" class="indextable genindextable"><tr>
  <td style="width: 33%; vertical-align: top;"><ul>
      <li><a href="command_line.html#command_line.history.HistoryTable.first">first() (command_line.history.HistoryTable method)</a>
</li>
      <li><a href="command_line.html#command_line.style.BaseStyle.fore">fore (command_line.style.BaseStyle attribute)</a>

      <ul>
        <li><a href="command_line.html#command_line.style.BlackRedStyle.fore">(command_line.style.BlackRedStyle attribute)</a>
</li>
      </ul></li>
  </ul></td>
  <td style="width: 33%; vertical-align: top;"><ul>
      <li><a href="command_line.html#command_line.colorful.foreground_replace">foreground_replace() (in module command_line.colorful)</a>
</li>
  </ul></td>
</tr></table>

<h2 id="G">G</h2>
<table style="width: 100%" class="indextable genindextable"><tr>
  <td style="width: 33%; vertical-align: top;"><ul>
      <li><a href="command_line.html#command_line.history.HistoryTable.get">get() (command_line.history.HistoryTable method)</a>
</li>
      <li><a href="command_line.html#command_line.colorful.get_back_color">get_back_color() (in module command_line.colorful)</a>
</li>
      <li><a href="command_line.html#command_line.colorful.get_back_reset">get_back_reset() (in module command_line.colorful)</a>
</li>
      <li><a href="command_line.html#command_line.shell.BaseShell.get_command">get_command() (command_line.shell.BaseShell method)</a>
</li>
  </ul></td>
  <td style="width: 33%; vertical-align: top;"><ul>
      <li><a href="command_line.html#command_line.colorful.get_fore_color">get_fore_color() (in module command_line.colorful)</a>
</li>
      <li><a href="command_line.html#command_line.colorful.get_fore_reset">get_fore_reset() (in module command_line.colorful)</a>
</li>
      <li><a href="command_line.html#command_line.shell.BaseShell.get_guidance">get_guidance() (command_line.shell.BaseShell method)</a>
</li>
      <li><a href="command_line.examples.html#command_line.examples.example_shell.ExampleShell.get_welcome_message">get_welcome_message() (command_line.examples.example_shell.ExampleShell method)</a>

      <ul>
        <li><a href="command_line.html#command_line.shell.BaseShell.get_welcome_message">(command_line.shell.BaseShell method)</a>
</li>
      </ul></li>
  </ul></td>
</tr></table>

<h2 id="H">H</h2>
<table style="width: 100%" class="indextable genindextable"><tr>
  <td style="width: 33%; vertical-align: top;"><ul>
      <li><a href="command_line.html#command_line.shell.BaseShell.history">history (command_line.shell.BaseShell attribute)</a>
</li>
      <li><a href="command_line.html#command_line.history.HistoryTable">HistoryTable (class in command_line.history)</a>
</li>
  </ul></td>
  <td style="width: 33%; vertical-align: top;"><ul>
      <li><a href="command_line.html#command_line.style.BaseStyle.how_to_clear">how_to_clear() (command_line.style.BaseStyle method)</a>
</li>
      <li><a href="command_line.html#command_line.style.BaseStyle.how_to_input">how_to_input() (command_line.style.BaseStyle method)</a>
</li>
      <li><a href="command_line.html#command_line.style.BaseStyle.how_to_print">how_to_print() (command_line.style.BaseStyle method)</a>
</li>
  </ul></td>
</tr></table>

<h2 id="I">I</h2>
<table style="width: 100%" class="indextable genindextable"><tr>
  <td style="width: 33%; vertical-align: top;"><ul>
      <li><a href="command_line.html#command_line.shell.BaseShell.input">input() (command_line.shell.BaseShell method)</a>

      <ul>
        <li><a href="command_line.html#command_line.style.BaseStyle.input">(command_line.style.BaseStyle method)</a>
</li>
      </ul></li>
  </ul></td>
  <td style="width: 33%; vertical-align: top;"><ul>
      <li><a href="command_line.html#command_line.style.BaseStyle.input_stream">input_stream (command_line.style.BaseStyle attribute)</a>
</li>
      <li><a href="command_line.html#command_line.shell.BaseShell.IS_ECHO_WELCOME_MESSAGE">IS_ECHO_WELCOME_MESSAGE (command_line.shell.BaseShell attribute)</a>
</li>
  </ul></td>
</tr></table>

<h2 id="K">K</h2>
<table style="width: 100%" class="indextable genindextable"><tr>
  <td style="width: 33%; vertical-align: top;"><ul>
      <li><a href="command_line.html#command_line.shell.BaseShell.keyboard_interrupt_action">keyboard_interrupt_action() (command_line.shell.BaseShell method)</a>
</li>
  </ul></td>
</tr></table>

<h2 id="L">L</h2>
<table style="width: 100%" class="indextable genindextable"><tr>
  <td style="width: 33%; vertical-align: top;"><ul>
      <li><a href="command_line.html#command_line.history.HistoryTable.last">last() (command_line.history.HistoryTable method)</a>
</li>
  </ul></td>
  <td style="width: 33%; vertical-align: top;"><ul>
      <li><a href="command_line.html#command_line.history.HistoryTable.length">length() (command_line.history.HistoryTable method)</a>
</li>
  </ul></td>
</tr></table>

<h2 id="M">M</h2>
<table style="width: 100%" class="indextable genindextable"><tr>
  <td style="width: 33%; vertical-align: top;"><ul>
      <li><a href="command_line.examples.html#command_line.examples.example_shell.main">main() (in module command_line.examples.example_shell)</a>
</li>
      <li>
    module

      <ul>
        <li><a href="command_line.html#module-command_line">command_line</a>
</li>
        <li><a href="command_line.html#module-command_line.colorful">command_line.colorful</a>
</li>
        <li><a href="command_line.examples.html#module-command_line.examples">command_line.examples</a>
</li>
        <li><a href="command_line.examples.html#module-command_line.examples.example_shell">command_line.examples.example_shell</a>
</li>
        <li><a href="command_line.html#module-command_line.exceptions">command_line.exceptions</a>
</li>
        <li><a href="command_line.html#module-command_line.history">command_line.history</a>
</li>
        <li><a href="command_line.html#module-command_line.shell">command_line.shell</a>
</li>
        <li><a href="command_line.html#module-command_line.style">command_line.style</a>
</li>
      </ul></li>
  </ul></td>
</tr></table>

<h2 id="O">O</h2>
<table style="width: 100%" class="indextable genindextable"><tr>
  <td style="width: 33%; vertical-align: top;"><ul>
      <li><a href="command_line.html#command_line.shell.BaseShell.other_error_except">other_error_except() (command_line.shell.BaseShell method)</a>
</li>
  </ul></td>
  <td style="width: 33%; vertical-align: top;"><ul>
      <li><a href="command_line.html#command_line.style.BaseStyle.output_stream">output_stream (command_line.style.BaseStyle attribute)</a>
</li>
  </ul></td>
</tr></table>

<h2 id="P">P</h2>
<table style="width: 100%" class="indextable genindextable"><tr>
  <td style="width: 33%; vertical-align: top;"><ul>
      <li><a href="command_line.examples.html#command_line.examples.example_shell.ExampleShell.parse">parse() (command_line.examples.example_shell.ExampleShell method)</a>

      <ul>
        <li><a href="command_line.html#command_line.shell.BaseShell.parse">(command_line.shell.BaseShell method)</a>
</li>
      </ul></li>
  </ul></td>
  <td style="width: 33%; vertical-align: top;"><ul>
      <li><a href="command_line.html#command_line.shell.BaseShell.program_need_quit_action">program_need_quit_action() (command_line.shell.BaseShell method)</a>
</li>
      <li><a href="command_line.html#command_line.exceptions.ProgramNeedQuitException">ProgramNeedQuitException</a>
</li>
      <li><a href="command_line.html#command_line.exceptions.ProgramStautsException">ProgramStautsException</a>
</li>
  </ul></td>
</tr></table>

<h2 id="Q">Q</h2>
<table style="width: 100%" class="indextable genindextable"><tr>
  <td style="width: 33%; vertical-align: top;"><ul>
      <li><a href="command_line.html#command_line.exceptions.QuitException">QuitException</a>
</li>
  </ul></td>
</tr></table>

<h2 id="R">R</h2>
<table style="width: 100%" class="indextable genindextable"><tr>
  <td style="width: 33%; vertical-align: top;"><ul>
      <li><a href="command_line.html#command_line.shell.BaseShell.run">run() (command_line.shell.BaseShell method)</a>
</li>
  </ul></td>
</tr></table>

<h2 id="S">S</h2>
<table style="width: 100%" class="indextable genindextable"><tr>
  <td style="width: 33%; vertical-align: top;"><ul>
      <li><a href="command_line.html#command_line.shell.BaseShell.set_style">set_style() (command_line.shell.BaseShell method)</a>
</li>
  </ul></td>
</tr></table>

<h2 id="T">T</h2>
<table style="width: 100%" class="indextable genindextable"><tr>
  <td style="width: 33%; vertical-align: top;"><ul>
      <li><a href="command_line.html#command_line.style.BaseStyle.typewriter">typewriter (command_line.style.BaseStyle attribute)</a>

      <ul>
        <li><a href="command_line.html#command_line.style.BlackRedStyle.typewriter">(command_line.style.BlackRedStyle attribute)</a>
</li>
      </ul></li>
  </ul></td>
  <td style="width: 33%; vertical-align: top;"><ul>
      <li><a href="command_line.html#command_line.style.BaseStyle.typewriter_inv">typewriter_inv (command_line.style.BaseStyle attribute)</a>

      <ul>
        <li><a href="command_line.html#command_line.style.BlackRedStyle.typewriter_inv">(command_line.style.BlackRedStyle attribute)</a>
</li>
      </ul></li>
  </ul></td>
</tr></table>

<h2 id="U">U</h2>
<table style="width: 100%" class="indextable genindextable"><tr>
  <td style="width: 33%; vertical-align: top;"><ul>
      <li><a href="command_line.examples.html#command_line.examples.example_shell.ExampleShell.user_need_quit_action">user_need_quit_action() (command_line.examples.example_shell.ExampleShell method)</a>

      <ul>
        <li><a href="command_line.html#command_line.shell.BaseShell.user_need_quit_action">(command_line.shell.BaseShell method)</a>
</li>
      </ul></li>
  </ul></td>
  <td style="width: 33%; vertical-align: top;"><ul>
      <li><a href="command_line.html#command_line.exceptions.UserNeedQuitException">UserNeedQuitException</a>
</li>
  </ul></td>
</tr></table>

<h2 id="W">W</h2>
<table style="width: 100%" class="indextable genindextable"><tr>
  <td style="width: 33%; vertical-align: top;"><ul>
      <li><a href="command_line.html#command_line.shell.BaseShell.WELCOME_MESSAGE">WELCOME_MESSAGE (command_line.shell.BaseShell attribute)</a>
</li>
  </ul></td>
</tr></table>



           </div>
           
          </div>
          <footer>

  <hr/>

  <div role="contentinfo">
    <p>
        &#169; Copyright 2021, Xie Zheyuan.

    </p>
  </div>
    
    
    
    Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
    
    <a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
    
    provided by <a href="https://readthedocs.org">Read the Docs</a>. 

</footer>
        </div>
      </div>

    </section>

  </div>
  

  <script type="text/javascript">
      jQuery(function () {
          SphinxRtdTheme.Navigation.enable(true);
      });
  </script>

  
  
    
   

</body>
</html>